apply code review #29272
Merged
apply code review #29272
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| managedClusters.json | 2024-04-02-preview(80fa3f0) | 2024-02-01(main) |
| managedClusters.json | 2024-04-02-preview(80fa3f0) | 2024-03-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has a different 'maximum' value than the previous one. New: aks/preview/2024-04-02-preview/managedClusters.json#L4209:9 Old: aks/preview/2024-03-02-preview/managedClusters.json#L4198:9 |
|
| The new version has a different 'minimum' value than the previous one. New: aks/preview/2024-04-02-preview/managedClusters.json#L4209:9 Old: aks/preview/2024-03-02-preview/managedClusters.json#L4198:9 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-04 | package-preview-2024-04(80fa3f0) | package-preview-2024-04(FumingZhang-containerservice-Microsoft.ContainerService-2024-04-02-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/preview/2024-04-02-preview/managedClusters.json#L52 |
|
Operations API path must follow the schema provided in the common types. Location: aks/preview/2024-04-02-preview/managedClusters.json#L53 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L74 |
|
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L80 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L116 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2024-04-02-preview/managedClusters.json#L137 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L237 |
|
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/preview/2024-04-02-preview/managedClusters.json#L278 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L336 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L381 |
|
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L381 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L429 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L569 |
|
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: aks/preview/2024-04-02-preview/managedClusters.json#L676 |
|
The patch operation body parameter schema should contain property 'identity'. Location: aks/preview/2024-04-02-preview/managedClusters.json#L695 |
|
The async patch operation should return 202. Location: aks/preview/2024-04-02-preview/managedClusters.json#L713 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L723 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L781 |
|
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/preview/2024-04-02-preview/managedClusters.json#L841 |
|
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1011 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1055 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1223 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1350 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L1366 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L1565 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1569 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2024-04-02-preview/managedClusters.json#L1589 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1608 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1654 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1670 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced May 30, 2024
Closed
FumingZhang
reviewed
May 30, 2024
...ource-manager/Microsoft.ContainerService/aks/preview/2024-04-02-preview/managedClusters.json
Outdated
Show resolved
Hide resolved
FumingZhang
approved these changes
May 30, 2024
FumingZhang
merged commit c868754
into
Azure:FumingZhang-containerservice-Microsoft.ContainerService-2024-04-02-preview
24 of 29 checks passed
Merged
7 tasks
razvanbadea-msft
pushed a commit
that referenced
this pull request
Jun 11, 2024
…iew/2024-04-02-preview (#29061) * Adds base for updating Microsoft.ContainerService/aks from version preview/2024-03-02-preview to version 2024-04-02-preview * Updates readme * Updates API version in new specs and examples * add undrainableNodeBehavior property (#28919) * add undrainableNodeBehavior property * fix some spell errors * fix some grammer issues * MixSku Pool Autoscale mode API Change (#29052) * MixSku Pool Autoscale mode API Change * Prettier --------- Co-authored-by: wenxuanW <wenxuanwang@microsoft.com> * Add swagger defination for IMDS restriction feature (#29044) * Add swagger defination for IMDS restriction feature * update swagger * fix spell * add none to outbound type in aks managedCluster (#29095) * add componentsByReleases (#29002) * update(retina): update adv networking to note additional costs (#29245) * apply code review (#29272) * apply code review * remove wireserver description because it's not link local address * apply code review * remove(monitoring): remove network monitoring profile from api 04-02 preview (#29279) --------- Co-authored-by: zjpjack-github <136433002+zjpjack-github@users.noreply.github.com> Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com> Co-authored-by: wenxuanW <wenxuanwang@microsoft.com> Co-authored-by: Tongyao Si <tosi@microsoft.com> Co-authored-by: Fan Shang Xiang <fanshangxiang@gmail.com> Co-authored-by: Shaoru Hu <49520642+HuShaoRu@users.noreply.github.com> Co-authored-by: Steven Nguyen <30740718+snguyen64@users.noreply.github.com>
markcowl
pushed a commit
to markcowl/azure-rest-api-specs
that referenced
this pull request
Jun 11, 2024
…iew/2024-04-02-preview (Azure#29061) * Adds base for updating Microsoft.ContainerService/aks from version preview/2024-03-02-preview to version 2024-04-02-preview * Updates readme * Updates API version in new specs and examples * add undrainableNodeBehavior property (Azure#28919) * add undrainableNodeBehavior property * fix some spell errors * fix some grammer issues * MixSku Pool Autoscale mode API Change (Azure#29052) * MixSku Pool Autoscale mode API Change * Prettier --------- Co-authored-by: wenxuanW <wenxuanwang@microsoft.com> * Add swagger defination for IMDS restriction feature (Azure#29044) * Add swagger defination for IMDS restriction feature * update swagger * fix spell * add none to outbound type in aks managedCluster (Azure#29095) * add componentsByReleases (Azure#29002) * update(retina): update adv networking to note additional costs (Azure#29245) * apply code review (Azure#29272) * apply code review * remove wireserver description because it's not link local address * apply code review * remove(monitoring): remove network monitoring profile from api 04-02 preview (Azure#29279) --------- Co-authored-by: zjpjack-github <136433002+zjpjack-github@users.noreply.github.com> Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com> Co-authored-by: wenxuanW <wenxuanwang@microsoft.com> Co-authored-by: Tongyao Si <tosi@microsoft.com> Co-authored-by: Fan Shang Xiang <fanshangxiang@gmail.com> Co-authored-by: Shaoru Hu <49520642+HuShaoRu@users.noreply.github.com> Co-authored-by: Steven Nguyen <30740718+snguyen64@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.